docs: correct categoryLinkSource supported values#1447
Merged
Conversation
Remove the unsupported `none` value, document `auto`, and correct the description of `tag` to reflect the current `doc`-type link behavior. Note that omitting the option produces the implicit "no link config" behavior that `none` previously denoted (PR #495). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Apply the same correction to the demo site's options table so the hosted docs match the package READMEs. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
Size Change: 0 B Total Size: 2.26 MB ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 8337b8f): https://docusaurus-openapi-36b86--pr1447-t4i8z4km.web.app (expires Mon, 11 May 2026 19:04:02 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
nonevalue from thecategoryLinkSourcedocs (Joi rejects it as invalid).autovalue, which sets the link config togenerated-index(added in Breaking: Default categoryLinkSource to none, addautooption #495).tagdescription — it now produces adoc-type link to the generated tag index page, notgenerated-index.nonepreviously denoted.Fixes #1229
Test plan
🤖 Generated with Claude Code